Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix FATAL: role "postgres" does not exists for docker compose deployment #8240

Merged
merged 3 commits into from
Dec 4, 2024

Conversation

robert-oleynik
Copy link
Contributor

@robert-oleynik robert-oleynik commented Nov 27, 2024

URL of deployed dev instance (used for testing):

  • None: Only affects instances deployed with docker compose.

Steps to test:

  • Start a new WebKnossos instance with docker compose up -d webknossos and attach to the logs of postgres docker compose logs -f webknossos-postgres-persistent-1. These log should not contains the above error message.
  • Note This error only effects the healthcheck and not postgres itself.

TODO

  • Healthcheck fails, but postgres is reported as healthy (pg_isready reports postgres as running, but does not check the user/db availability; The error is logged by postgres)

Issues:

  • fixes error message FATAL: role "postgres" does not exists

(Please delete unneeded items, merge only when none are left open)

@robert-oleynik robert-oleynik self-assigned this Nov 27, 2024
Copy link
Contributor

coderabbitai bot commented Nov 27, 2024

📝 Walkthrough

Walkthrough

The pull request introduces multiple updates to the WEBKNOSSOS project, including new functionalities for dataset management and user interface improvements. Key changes involve the ability to ignore specific format prefixes in remote URIs, enhanced dataset tooltips, and the renaming of "resolution" to "magnification." Bug fixes address various issues in dataset handling, including performance and validation errors. Additionally, the docker-compose.yml file has been modified to improve the health check for the postgres service, ensuring it accurately reflects the database's readiness.

Changes

File Change Summary
CHANGELOG.unreleased.md Updated to document new features: ignoring format prefixes, dataset volume tooltips, renaming "resolution" to "magnification," asynchronous image reading, and various bug fixes.
docker-compose.yml Updated health check command for postgres service to include database name, with minor formatting adjustments.

Possibly related PRs

Suggested labels

bug, enhancement

Poem

🐰 In the garden where data grows,
New features bloom, and progress flows.
With magnification, we explore,
As bounding boxes open new doors.
Bugs are fixed, and health checks shine,
In WEBKNOSSOS, all is fine! 🌼


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between c3729ea and 763003e.

📒 Files selected for processing (2)
  • CHANGELOG.unreleased.md (1 hunks)
  • docker-compose.yml (1 hunks)
🔇 Additional comments (3)
CHANGELOG.unreleased.md (1)

39-39: LGTM! Clear and well-placed changelog entry.

The changelog entry accurately describes the fix and is properly categorized under the "Fixed" section with the correct PR reference.

docker-compose.yml (2)

226-228: LGTM! Health check timing parameters are well-balanced.

The timing configuration provides a good balance between responsiveness and reliability:

  • 2s interval ensures quick health status updates
  • 5s timeout accommodates temporary slowdowns
  • 30 retries (60s total) allows sufficient time for database initialization

225-225: LGTM! Health check now correctly matches database configuration.

The updated health check command properly aligns with the PostgreSQL container configuration by:

  1. Using the correct database user (webknossos_user instead of postgres)
  2. Explicitly checking the webknossos database accessibility

Let's verify the configuration consistency:

✅ Verification successful

Health check configuration is consistent and well-configured

The verification confirms that:

  • Database user (webknossos_user) and database name (webknossos) in the health check command match the PostgreSQL environment variables
  • Health check timing parameters are reasonable:
    • 2s interval between checks
    • 5s timeout for each check
    • 30 retries before considering the service unhealthy
🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify that health check parameters match the PostgreSQL configuration

# Check if the database name and user in health check match the environment variables
rg -A 3 'POSTGRES_(DB|USER)' docker-compose.yml

# Check if the health check timing parameters are reasonable
rg -A 3 'healthcheck:.*postgres' docker-compose.yml

Length of output: 799


Script:

#!/bin/bash
# Let's check the healthcheck configuration parameters for postgres service
rg -B 2 -A 5 'healthcheck:.*postgres|test:.*pg_isready' docker-compose.yml

Length of output: 306


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@robert-oleynik robert-oleynik marked this pull request as ready for review December 3, 2024 14:48
@fm3 fm3 requested a review from normanrz December 3, 2024 17:29
@robert-oleynik robert-oleynik merged commit 2781061 into master Dec 4, 2024
3 checks passed
@robert-oleynik robert-oleynik deleted the fix-postgres-healthcheck branch December 4, 2024 08:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants